home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / ae_14.zip / AEMANUAL.TXT < prev    next >
Text File  |  1991-03-22  |  23KB  |  521 lines
  1.                        AE -- Another Editor
  2.                            Version 1.4
  3.  
  4.                               Manual
  5.  
  6.  
  7.  
  8.  
  9. Why Another Editor?
  10. -------------------
  11.  
  12.   There are already so many editors for MS-DOS, why take the 
  13.   trouble to invent the wheel once more? Well, I couldn't find 
  14.   an editor that suited my needs. I wanted one that:
  15.  
  16.   - could do simple ASCII editing, for writing programs and 
  17.   small texts.
  18.  
  19.   - had user-definable keyboard macros, in case I had some 
  20.   repetitive editing to do.
  21.  
  22.   - was small, so that it could be run from floppy.
  23.  
  24.   - was efficient: the most important options, like cursor 
  25.   movement and cutting/pasting must be done with a single 
  26.   keystroke.
  27.  
  28.   The result is AE. If you are an unexperienced PC user, then 
  29.   read on. I hope that this manual will explain enough to let 
  30.   you use AE effectively. If you are already familiar with other 
  31.   editors like the Norton editor or Borland's Turbo editors, you 
  32.   should have little trouble getting started with AE. You can 
  33.   get a list of AE's commands by pressing the F1 key. However, 
  34.   some of the details may not be immediately clear. Below, you 
  35.   will find a point-by point discussion of these.
  36.  
  37.  
  38. 1. Entrance and exit
  39. --------------------
  40.  
  41.   The editor is started by typing "AE" on the DOS command line. 
  42.   (If you hadn't guessed!) Alternatively, you can start editing 
  43.   an existing file by giving the filename as an argument (see
  44.   also the section "Loading and saving files" below).
  45.  
  46.   At any point during editing, when you are giving a command but 
  47.   have changed your mind, you can press the Escape key to exit. 
  48.   The command will not be executed, and AE will return to its 
  49.   normal state. Escape will not terminate the program. To do 
  50.   this, you must use the exit command Alt-X.
  51.  
  52.  
  53. 2. Loading and saving files
  54. ---------------------------
  55.  
  56.   You can load a file into AE either by typing it as an argument 
  57.   on the command line when starting (e.g. 'AE MYFILE.TXT'), or 
  58.   by pressing F3 once AE is running. 
  59.  
  60.   AE can handle filenames with wildcards. If the filename you 
  61.   enter contains a '?' (for any single character) or a '*' (for 
  62.   any series of characters), then you will get on your screen a 
  63.   list with the names of all files that match the wildcard
  64.   pattern. So, if you want to choose from all files in the 
  65.   current directory, try to load '*.*'. In the list, you can 
  66.   move a selection bar with the 'up' and 'down' keys, or PgUp 
  67.   and PgDn. You can also select a file from the file list by 
  68.   pressing the first letter of its name. So if for instance you 
  69.   press the "A" key repeatedly, the selection bar will step 
  70.   through all the file names beginning with an A. When you have 
  71.   selected the file you want, press Return to load it.
  72.  
  73.   On the bottom of the file list you will find the directories 
  74.   that the current directory is connected to. Directory names 
  75.   are indicated by a preceding "»". If you press Enter with the 
  76.   selection bar on a directory, AE will scan that directory and 
  77.   show you a new file list. In this way you can search the whole 
  78.   disk for the file you want.
  79.  
  80.   It is also possible to read the contents of another file and 
  81.   add them to the current one. This is the 'INSERT FILE' 
  82.   option. You can use it by pressing Shift-F3.
  83.  
  84.   Saving a file can be done by pressing F2. If the file does not 
  85.   have a name yet, AE will ask you to give it one. The name of 
  86.   the file you are editing can be seen on the statusline. If you 
  87.   want to store your file with a different name, then you should 
  88.   use Shift-F2. You will then be asked to enter the new filename.
  89.  
  90.   AE will notice if you have changed a file. You can also see 
  91.   this by the asterisk beside the filename on the statusline. If 
  92.   you have made changes and try to load another file without 
  93.   saving the old one first, AE will notify you and ask if the 
  94.   old file should be saved first. The same goes if you try to 
  95.   quit the program without having saved your file.
  96.  
  97.  
  98. 3. Cursor movement
  99. ------------------
  100.  
  101.   The keys to move the cursor are the same as just about every 
  102.   other editor for MS-DOS:
  103.  
  104.   up, down, left, right:   move one position in that direction 
  105.   Ctrl-left, Ctrl-right:   go to start of previous/next word 
  106.   Home, End:               go to begin/end of the current line 
  107.   Ctrl-Home, Ctrl-End:     go to first/last line on the screen 
  108.   PgUp,PgDn:               move one screenful up/down 
  109.   Ctrl-PgUp, Ctrl-PgDn:    go to begin/end of file
  110.  
  111.  
  112. 4. Typing characters and deleting them
  113. --------------------------------------
  114.  
  115.   This is, again, very much like other editors. When you type in 
  116.   a character, it will either be inserted into the text, or it 
  117.   will replace the character under the cursor. This depends on 
  118.   the mode, which is either 'Insert' or 'Overwrite'. You can 
  119.   switch between these modes by pressing the Ins key. The 
  120.   current mode is shown on the statusline .
  121.  
  122.   For some commands you will be asked to enter some text (like a 
  123.   filename for loading a file). The text will appear on the 
  124.   bottom line of the screen, temporarily erasing the statusline. 
  125.   Keys that work here usually have the same effect as in normal 
  126.   typing: left, right, Home, End, Delete and Backspace. 
  127.   Overwrite mode does not exist in these cases; characters are 
  128.   always inserted. Another peculiarity is that if the first key 
  129.   you press is a character key, the text that was present will 
  130.   be erased. If you start with any other key, you will modify 
  131.   the existing text. When you have finished your input, you can 
  132.   press Enter to proceed.
  133.  
  134.   To remove a character you can either use the Backspace or the 
  135.   Delete key. The latter will remove the character under the 
  136.   cursor, the former removes the one directly left to it. There
  137.   also are commands to remove more than one character at a time:
  138.   Delete line (Alt-L) deletes the current line, delete word 
  139.   forward (Alt-W) deletes text from the cursor to the beginning 
  140.   of the next word. (Words can be separated by spaces or any of 
  141.   the characters : ; , or.)
  142.  
  143.  
  144. 5. Cutting and pasting
  145. ----------------------
  146.  
  147.   The keys mentioned so far may be fine to add and remove a 
  148.   couple of characters, but to handle larger pieces of text you 
  149.   need to cut and paste. The first step for this is to move the 
  150.   cursor to one end of the piece of text, and then place a mark 
  151.   with the F5 key. The mark itself is not shown, but when you 
  152.   move the cursor away from the mark, you will see a highlighted 
  153.   piece between the mark and the cursor. This is called the 
  154.   block. Now you can delete the block (with Shift-F6), copy it 
  155.   to the paste buffer (with F7), or cut it (with F6). The 
  156.   difference between cut and copy is that cutting the block 
  157.   removes it from your text, while copy makes no changes in the 
  158.   text. Unless you have chosen to delete, the contents of the
  159.   block are now stored in the paste buffer. You can insert the 
  160.   contents of the paste buffer into a different part of the 
  161.   text, or into the text in a different window. Move the cursor
  162.   to the position where you want to insert it, then press F8. 
  163.   Pasting does not change the paste buffer, so pressing F8 more 
  164.   than once will insert multiple copies of the block.
  165.  
  166.   If you don't want to do anything with the block you can remove 
  167.   the mark with Shift-F5.
  168.  
  169.   The last option I want to mention is comparing the block to 
  170.   the paste buffer. This can be handy if you want to check 
  171.   whether two pieces of text are completely equal or not. After 
  172.   cutting or copying the first piece, select the second piece, 
  173.   then press Shift-F7. The result will be shown on the 
  174.   statusline.
  175.  
  176.  
  177. 6. Searching and replacing text
  178. -------------------------------
  179.  
  180.   You can search for a sequence of characters in the text and, 
  181.   optionally, replace it by another. These commands are started 
  182.   with F4 and Shift-F4 respectively. You will first be asked to 
  183.   enter the text to look for, the text to replace it with (if 
  184.   you have pressed Shift-F4), and t